Skip to main content

Clear-IMJob

SYNOPSIS​

Clears Immich job queues

SYNTAX​

Clear-IMJob [[-Session] <ImmichSession>] [-Job] <String[]> [-FailedOnly] [-Force]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Clears completed, failed, or all jobs from specific job queues in Immich. This helps manage job queue cleanup and removes old job entries that are no longer needed.

EXAMPLES​

EXAMPLE 1​

Clear-IMJob -Job 'thumbnailGeneration'

Clears all jobs from the thumbnail generation queue.

EXAMPLE 2​

Clear-IMJob -Job 'faceDetection' -FailedOnly

Clears only failed jobs from the face detection queue.

EXAMPLE 3​

Clear-IMJob -Job 'metadataExtraction' -Force

Forcibly clears the metadata extraction job queue.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Job​

The type of job queue to clear. Valid values include thumbnailGeneration, metadataExtraction, videoConversion, faceDetection, and other job types.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FailedOnly​

Clears only failed jobs from the queue, leaving completed and pending jobs intact.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Force​

Forces the operation to proceed without additional confirmation for potentially disruptive actions.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

Use caution when clearing job queues as this may remove jobs that haven't completed yet. The FailedOnly parameter is recommended for routine maintenance.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github